/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.activiti.explorer.ui.content;

import com.vaadin.data.Validator.InvalidValueException;
import com.vaadin.ui.Component;
import org.activiti.engine.task.Attachment;


/**
 * Component that is capable of rendering an editable piece of related content.
 *
 * @author Frederik Heremans
 * @see AttachmentRendererManager
 */
public interface AttachmentEditorComponent extends Component {

    /**
     * Get the edited or created attachment based on the values filled in. <b>The
     * editor should save the attachment when this method is called.</b>
     *
     * @throws InvalidValueException when validation of the values failed. Editor should show
     *                               error-message in component.
     */
    Attachment getAttachment() throws InvalidValueException;
}
